/**
 * Copyright (c) 2006-2008, Alexander Potochkin
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the JXLayer project nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.jdesktop.jxlayer.plaf.item;

import java.util.EventObject;
import java.awt.*;
import org.jdesktop.jxlayer.JXLayer;

/**
 * {@code LayerItemChangeEvent} provides notification of changes
 * to a {@code LayerItem}.
 * 
 * @see LayerItem
 * @see LayerItemListener
 */
public class LayerItemChangeEvent extends EventObject {

    /**
     * Creates a new {@code LayerItemEvent} object.
     *
     * @param source the object on which the event initially occurred.
     * @throws IllegalArgumentException if source is null.
     */
    public LayerItemChangeEvent(LayerItem source) {
        super(source);
    }

    /**
     * Returns the {@link LayerItem} on which the event initially occurred.
     *
     * @return the {@link LayerItem} on which the event initially occurred.
     */
    public LayerItem getSource() {
        return (LayerItem) super.getSource();
    }

    /**
     * Since one {@code LayerItemChangeEvent} can be sent to multiple
     * {@link org.jdesktop.jxlayer.JXLayer}s, this method gives an opportunity
     * for the subclasses of {@code LayerItemChangeEvent} to define
     * the precise part of a {@link JXLayer} to be repainted.
     *
     * @param width the current width of a {@link JXLayer}
     * @param height the current height of a {@link JXLayer}
     * @return the part ofa {@link JXLayer} to be repainted  
     */
    public Shape getClip(int width, int height) {
        return null;
    }
}
